home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #5 & #6 / Amiga Plus CD - 1995 - No. 5 and 6.iso / pd / netz / archie / doc / archie.hlp < prev    next >
Text File  |  1995-08-16  |  6KB  |  180 lines
  1. 1 ARCHIE   
  2. ARCHIE is a utility to query the Archie anonymous FTP databases using
  3. Prospero.  It will check the databases for entries about the files that 
  4. are available via anonymous FTP from sites around the world.
  5.  
  6. Format:             $ ARCHIE [-option] <string>
  7.  
  8. This will query an ARCHIE server and ask it to look for all known sites 
  9. that have a file named `string' in their FTP area.  ARCHIE will wait and 
  10. then print out any matches.
  11.  
  12. 2 Options
  13. ARCHIE is originally a Unix utility so its options make use of 
  14. the Unix `-option' and not the VMS `/qualifier' syntax.
  15.  
  16. With the `-L' and `-N#' options you must enclose the option in
  17. double quotes (ie "-L" and "-N#") to prevent the server from
  18. translating them into lowercase options.
  19.  
  20. 3 -ecsr
  21. These are search-modifying options:
  22.  
  23.      -e   Exact string match.  (This is the default.)
  24.      -c   Search substrings paying attention to upper and lower case.
  25.      -s   Search substrings ignoring the case of the letters.
  26.      -r   Search using a regular expression.
  27.  
  28. `-c', `-s' and `-r' are mutually exclusive;  only the last one counts.  
  29.  
  30. If you specify `-e' with any of them the server will first check for an 
  31. exact match, then fall back to the case-sensitive, case-insensitive, or  
  32. regular expression search.  This is so if there are matches that are 
  33. particularly obvious, it will use a minimal amount of search time.
  34.  
  35. 3 -h <hostname>
  36. Instruct ARCHIE to query another ARCHIE server with the name 
  37. `hostname', instead of its default server.
  38.  
  39. ARCHIE is compiled with a specific default server host.  
  40. This default can be changed by defining the symbol ARCHIE_HOST 
  41. as one of the other available hosts.  The `-h' option will 
  42. override these defaults. 
  43.  
  44. (Use option -L to get the list of available hosts.)
  45.  
  46. 3 -o <filename>
  47. To redirect the output of ARCHIE to a file (rather than use the
  48. standard output), give the `filename' it should store the results in.
  49.  
  50. 3 -l          
  51. Output results in a form suitable for parsing by programs.
  52.  
  53. 3 -m#
  54. Specifies the maximum number of hits (matches) to return. 
  55. The default is 95 hits.
  56.  
  57. 3 -t
  58. Sort the results in reverse date order.
  59.  
  60. 3 -L
  61. Lists the Archie servers known to the program when it was
  62. compiled, as well as the name of the default Archie server.  
  63.  
  64.       (Note: You MUST put quotes around this argument 
  65.               or it will be converted to lowercase.)         
  66.  
  67. 3 -N[#]
  68. Sets the `niceness' of a query.  The default niceness is 0.
  69. Using `-N' without an argument sets it to 35765 (the maximum).
  70. If you use `-N' with an argument between 0 and 35765, it will 
  71. adjust itself accordingly.  
  72.  
  73.       (Note: You MUST put quotes around this argument 
  74.               or it will be converted to lowercase.)         
  75.  
  76. (See also the subtopic `Niceness')
  77.  
  78. 3 -V
  79. Provide some reassuring messages when a search is taking a long time.
  80.  
  81. 3 -v
  82. Print the version of the client.
  83.  
  84. 2 String
  85. This can be either the name of a file or a substring of a filename.
  86.  
  87. If you use a substring, then you must use one of the search-modifying
  88. options `-c', `-r' or `-s'.  Otherwise ARCHIE will only respond with
  89. only those files that match exactly the substring!
  90.  
  91. If the search string starts with a `-' you must precede it with 
  92. another `-'.  For example
  93.  
  94.      $ archie  -s  - -old
  95.  
  96. will search for all filenames that contain the string `-old'.
  97.  
  98. 2 Examples
  99. 1.          $ archie emacs
  100.  
  101.      This will find all anonymous FTP sites in the ARCHIE database
  102.      that have files named `emacs' somewhere in their FTP area.
  103.      (This particular query would probably return a lot of direc-
  104.      tories.)  
  105.  
  106. 2.          $ archie -c emacs
  107.  
  108.      This will produce a list of every file that contains the
  109.      string `emacs' anywhere in the filename.
  110.  
  111. 3.   Regular expressions may also be used for searches:
  112.  
  113.             $ archie -r '[xX][lL]isp'
  114.  
  115.      If a string is enclosed in brackets [] ARCHIE will attempt to 
  116.      match any single character from the string.  In the above example
  117.      it will try and match either `x' or `X' plus either `l' or `L' 
  118.      followed by `isp'.  It is recommended that you enclose the whole
  119.      expression in single quotes to prevent the server misinterpreting it.
  120.  
  121. 2 Niceness
  122. Niceness is the (Unix) concept of `being nice' to other users by 
  123. lowering the priority of non-urgent jobs.
  124.  
  125. You should use the `-N' option whenever you do not demand immediacy,  
  126. or when you are requesting things that could generate large responses.  
  127.  
  128. Here is a list of what would be considered as `nice' values that
  129. accurately reflect the priority of a request to the server.
  130.  
  131.           Normal              0
  132.           Nice                500
  133.           Nicer               1000
  134.           Very Nice           5000
  135.           Extremely Nice      10000
  136.           Nicest              32765
  137.  
  138. The last priority, Nicest, would be used when a job should wait until  
  139. the queue is essentially empty before running. You should pick one of
  140. these values to use, possibly modifying it slightly depending on where 
  141. you think your priority should land.  For example, 32760 would mean wait  
  142. until the queue is empty, but jump ahead of other jobs that are `Nicest'.
  143.  
  144. 2 Bugs
  145. There are none; only a few unexpected features.
  146.  
  147. 2 VMS Notes
  148. Please note that there are some options (e.g., -a) that aren't very
  149. useful under VMS, so are not documented in this help file.
  150.  
  151. To use the ARCHIE program, define it as a symbol to point to the
  152. ARCHIE.EXE image, or the arguments won't get processed properly:
  153.  
  154.     $ ARCHIE :== $THE$DISK:[SOME.DIR]ARCHIE
  155.  
  156. Any further enhancements for VMS for this client are welcome and
  157. encouraged.
  158.  
  159. 2 Background
  160. ARCHIE runs as a client and queries an Archie anonymous FTP database 
  161. looking for the specified search string, using the Prospero protocol.  
  162. This client is based on Prospero version Beta.4.2 and is provided to 
  163. encourage non-interactive use of the Archie servers (and subsequently 
  164. better performance on both sides).  
  165.  
  166. The ARCHIE service was conceived and implemented by Alan Emtage
  167. (bajan@cs.mcgill.ca), Peter Deutsch (peterd@cs.mcgill.ca), and 
  168. Bill Heelan (wheelan@cs.mcgill.ca).  The entire Internet is in 
  169. their debt.
  170.  
  171. The Prospero system was created by Clifford Neuman (bcn@isi.edu); 
  172. write to info-prospero@isi.edu for more information on the protocol 
  173. and its use.
  174.  
  175. This stripped client was put together by Brendan Kehoe 
  176. (brendan@cygnus.com), with modifications by Clifford Neuman 
  177. and George Ferguson (ferguson@cs.rochester.edu).
  178.  
  179. This help file was written by John Armstrong (armstrong@leva.leeds.ac.uk).
  180.